Class symantec.itools.awt.image.FadeFilter
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class symantec.itools.awt.image.FadeFilter

Object
   |
   +----ImageFilter
           |
           +----RGBImageFilter
                   |
                   +----symantec.itools.awt.image.FadeFilter

public class FadeFilter
extends RGBImageFilter
An Image filter to use for fading an Image towards a specified Color by a specified percent.

Version:
1.1, July 8, 1997
Author:
Symantec

Variable Index

 o errors
Error strings.
 o percent
The percentage to fade when filtering.
 o to_b
The blue value of the color to fade to when filtering.
 o to_g
The green value of the color to fade to when filtering.
 o to_r
The red value of the color to fade to when filtering.

Constructor Index

 o symantec.itools.awt.image.FadeFilter()
Constructs a default FadeFilter.
 o symantec.itools.awt.image.FadeFilter(double)
Constructs a FadeFilter.
 o symantec.itools.awt.image.FadeFilter(Color)
Constructs a FadeFilter.
 o symantec.itools.awt.image.FadeFilter(double, Color)
Constructs a FadeFilter.

Method Index

 o filterRGB(int, int, int)
Filters an RGB value using the current fade settings.
 o getFadeToColor()
Gets the color used to fade to when filtering.
 o getPercent()
Gets the percentage to fade when filtering.
 o setFadeToColor(Color)
Sets the color to fade to when filtering.
 o setPercent(double)
Sets the percentage to fade when filtering.

Variables

 o errors
protected transient java.util.ResourceBundle errors
Error strings.

 o percent
protected double percent
The percentage to fade when filtering.

See Also:
getPercent, setPercent
 o to_b
protected int to_b
The blue value of the color to fade to when filtering.

See Also:
getFadeToColor, setFadeToColor
 o to_g
protected int to_g
The green value of the color to fade to when filtering.

See Also:
getFadeToColor, setFadeToColor
 o to_r
protected int to_r
The red value of the color to fade to when filtering.

See Also:
getFadeToColor, setFadeToColor

Constructors

 o FadeFilter
public FadeFilter()
Constructs a default FadeFilter. By default the Image is faded 50% towards Color.lightGray.

See Also:
FadeFilter(double), FadeFilter(java.awt.Color), FadeFilter(double, java.awt.Color), setPercent, setFadeToColor
 o FadeFilter
public FadeFilter(double percent)
Constructs a FadeFilter. By default the Image is faded towards Color.lightGray.

Parameters:
percent - the percent to fade towards the specified color
See Also:
FadeFilter(), FadeFilter(java.awt.Color), FadeFilter(double, java.awt.Color), setFadeToColor
 o FadeFilter
public FadeFilter(Color fadeToColor)
Constructs a FadeFilter. By default the Image is faded 50%.

Parameters:
fadeToColor - the color to fade to
See Also:
FadeFilter(), FadeFilter(double), FadeFilter(double, java.awt.Color), setPercent
 o FadeFilter
public FadeFilter(double percent,
                  Color fadeToColor)
Constructs a FadeFilter.

Parameters:
percent - the percent to fade towards the specified color
fadeToColor - the color to fade to
See Also:
FadeFilter(), FadeFilter(double), FadeFilter(java.awt.Color)

Methods

 o filterRGB
public int filterRGB(int x,
                     int y,
                     int rgb)
Filters an RGB value using the current fade settings.

Parameters:
x - unused
y - unused
rgb - the rgb value to fade
Returns:
the faded rgb value
Overrides:
filterRGB in class RGBImageFilter
 o getFadeToColor
public java.awt.Color getFadeToColor()
Gets the color used to fade to when filtering.

Returns:
the color used to fade to
See Also:
setFadeToColor
 o getPercent
public double getPercent()
Gets the percentage to fade when filtering.

Returns:
the percentage to fade
See Also:
setPercent
 o setFadeToColor
public void setFadeToColor(Color fadeTo)
Sets the color to fade to when filtering.

Parameters:
fadeTo - the color to fade to
See Also:
getFadeToColor
 o setPercent
public void setPercent(double percent) throws IllegalArgumentException
Sets the percentage to fade when filtering.

Parameters:
percent - the percentage to fade
Throws: IllegalArgumentException
if the specified percentage value is unacceptable
See Also:
getPercent

All Packages  Class Hierarchy  This Package  Previous  Next  Index